hip.api.data.commons

Undocumented in source.

Members

Enums

HipAssetResult
enum HipAssetResult
Undocumented in source.

Functions

Asset
HipAssetUDA!T Asset(string path, T function(string) conversionFunc, int start, int end)
Asset
HipAssetUDA!void Asset(string path, int start, int end)
getModulesFromRoot
string[] getModulesFromRoot(string modules, string root)
Undocumented in source. Be warned that the author may not have intended to support it.
loadAsset
IHipAssetLoadTask loadAsset(string assetPath)
Undocumented in source. Be warned that the author may not have intended to support it.
loadAsset
IHipAssetLoadTask[] loadAsset(string assetPath, int start, int end)
Undocumented in source. Be warned that the author may not have intended to support it.
splitLines
string[] splitLines(string input)
Undocumented in source. Be warned that the author may not have intended to support it.

Interfaces

IHipAsset
interface IHipAsset
Undocumented in source.
IHipAssetLoadTask
interface IHipAssetLoadTask

IHipAssetLoadTask is the base return type from any asset you want to HipAssetManager.load{X}. The loading, unless otherwise stated, is asynchronous. For simple games, most of the time you won't need to directly used LoadTask as currently the engine loads all the assets at startup to make it easier to prototype a game without needing to think about those tasks.

IHipDeferrableText
interface IHipDeferrableText
Undocumented in source.
IHipDeferrableTexture
interface IHipDeferrableTexture

Maybe will be deprecated in future. This is common in web, but it is a pain to work with.

IHipDeserializable
interface IHipDeserializable
Undocumented in source.
IHipPreloadable
interface IHipPreloadable

Usage:

ILoadable
interface ILoadable
Undocumented in source.
IReloadable
interface IReloadable

OpenGL Renderer must implement IReloadable for when changing device orientation.

Mixin templates

ForeachAssetInClass
mixintemplate ForeachAssetInClass(T, alias foreachAsset)

foreachAsset: void foreachAsset(T)(string assetPath)

LoadAllAssets
mixintemplate LoadAllAssets(string modules)
Undocumented in source.
LoadReferencedAssets
mixintemplate LoadReferencedAssets(string[] modules)
Undocumented in source.
PreloadAssets
mixintemplate PreloadAssets()
Undocumented in source.

Structs

HipAssetUDA
struct HipAssetUDA(T)

Use @Asset instead of HipAsset.

Templates

FilterAsset
template FilterAsset(Attributes...)
Undocumented in source.
GetAssetUDA
template GetAssetUDA(Attributes...)
Undocumented in source.

Meta